isort の構成オプション

構成オプション

iosrt にはインポートのソートやフォーマットなどをカスタマイズできるように、多くの構成オプションが提供されています。

Pythonバージョン

isort に、指定された Python のバージョンに基づいて既知の標準ライブラリを設定するように指示します。デフォルトでは、任意の Python 3 バージョンがターゲットになると仮定し、バージョン間ですべての stdlib モジュールの組合わせを使用します。auto が指定された場合は、isort の実行に使用されたインタープリタのバージョン (現在は 39) が使用されます。

Type: String

Default: py3

Python & Config File Name: py_version

CLI Flags: --py、--python-version

トップへの強制

特定のインポートを適切なセクションの先頭に強制的に移動させます。

Type: Frozenset

Default: frozenset()

Python & Config File Name: force_to_top

CLI Flags: -t、--top

スキップ

isort がスキップするファイルを指定します。複数のファイルをスキップしたい場合は、 --skip file1 --skip file2 と2回指定します。値には、ファイル名、ディレクトリ名、ファイルパスを指定できます。入れ子になったパスの中のすべてのファイルをスキップするには --skip-glob を使います。

Type: Frozenset

Default: ('.bzr', '.direnv', '.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.svn', '.tox', '.venv', '__pypackages__', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv')

Python & Config File Name: skip

CLI Flags: -s、--slip

スキップの拡張

isort がスキップすべきファイルを追加するために --skipオプションを拡張します。複数のファイルをスキップしたい場合は、 --skip file1 --skip file2 と 2 回指定する必要があります。値には、ファイル名、ディレクトリ名、ファイルパスを指定できます。入れ子になったパスの中のすべてのファイルをスキップするには --skip-glob を使います。

Type: Frozenset

Default: frozenset()

Python & Config File Name: extend_skip

CLI Flags: --extend-skip

スキップGlob

入れ子になったパスの中のすべてのファイルをスキップします。

Type: Frozenset

Default: frozenset()

Python & Config File Name: skip_glob

CLI Flags: --sg、--skip-glob

スキップGlobの拡張

--skip-glob でスキップさせるファイルを追加します

Type: Frozenset

Default: frozenset()

Python & Config File Name: extend_skip_glob

CLI Flags: --extend_skip_glob

Gitignoreのスキップ

プロジェクトを git リポジトリとして扱い、.gitignore にあるファイルを無視します。注：このためには、gitがインストールされていて、isortと同じシェルからアクセスできる必要があります。

Type: Bool

Default: False

Python & Config File Name: skip_gitignore

CLI Flags: --gitignore、--skip_gitignore

ラインの長さ

インポート行の最大の長さを指定します。長いインポートをラップするときに使用します。

Type: Int

Default: 79

Python & Config File Name: line_length

CLI Flags: -l、-w、--line-length、--line-width

折り返しの長さ

折り返される行の長さを指定します。設定されていない場合は line_length が使用されます。注意：wrap_lengthはline_lengthよりも小さいか、同じでなければなりません。

Type: Int

Default: 0

Python & Config File Name: wrap_length

CLI Flags: --wl、--wrap-length

行末を指定

行末を指定された値に強制的に変更します。設定されていない場合は、ファイルごとに値が推測されます。

Type: String

Default: ''

Python & Config File Name: line_ending

CLI Flags: --le、 --line-ending

セクション

インポートをセクションで分類する

Type: Tuple

Default: ('FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER')

Python & Config File Name: sections

CLI Flags: ありません

セクションなし

インポートの分類をせず、すべてのインポートを同じセクションにまとめる

Type: Bool

Default: False

Python & Config File Name: no_sections

CLI Flags: --ds、--no-sections

既知のFutureライブラリ

isort がモジュールを Python 内部のFuture互換ライブラリの一部として認識するように強制します。警告: これは future 処理の動作をオーバーライドするため、実行できないコードになる可能性があります。six のような依存関係を追加したい場合は、カスタムセクションを使って --future の下に別のセクションを作成するのが良い方法です。custom-sections-and-ordering および Issue-1463 を参照してください。

Type: Frozenset

Default: ('__future__',)

Python & Config File Name: known_future_library

CLI Flags: -f、 --future

既知のサードパーティライブラリ

サードパーティのライブラリの一部であるモジュールをisortに強制的に認識させます。

Type: Frozenset

Default: frozenset()

Python & Config File Name: known_third_party

CLI Flags: -o 、 --thirdparty

既知のプロジェクトライブラリ

isortにモジュールが現在のpythonプロジェクト（First Party) の一部であることを認識させます。

Type: Frozenset

Default: frozenset()

Python & Config File Name: known_first_party

CLI Flags: -p 、 --project

既知のローカルフォルダ

isort にモジュールがローカルフォルダであることを認識させます。一般的に、これは相対的なインポートのために予約されています (from . import module)。

Type: Frozenset

Default: frozenset()

Python & Config File Name: known_local_folder

CLI Flags: --known_local_folder

既知の標準ライブラリ

isortにPythonの標準ライブラリの一部であるモジュールを認識させます。

Type: Frozenset

Default: ('_ast', '_dummy_thread', '_thread', 'abc', 'aifc', 'argparse', 'array', 'ast', 'asynchat', 'asyncio', 'asyncore', 'atexit', 'audioop', 'base64', 'bdb', 'binascii', 'binhex', 'bisect', 'builtins', 'bz2', 'cProfile', 'calendar', 'cgi', 'cgitb', 'chunk', 'cmath', 'cmd', 'code', 'codecs', 'codeop', 'collections', 'colorsys', 'compileall', 'concurrent', 'configparser', 'contextlib', 'contextvars', 'copy', 'copyreg', 'crypt', 'csv', 'ctypes', 'curses', 'dataclasses', 'datetime', 'dbm', 'decimal', 'difflib', 'dis', 'distutils', 'doctest', 'dummy_threading', 'email', 'encodings', 'ensurepip', 'enum', 'errno', 'faulthandler', 'fcntl', 'filecmp', 'fileinput', 'fnmatch', 'formatter', 'fpectl', 'fractions', 'ftplib', 'functools', 'gc', 'getopt', 'getpass', 'gettext', 'glob', 'graphlib', 'grp', 'gzip', 'hashlib', 'heapq', 'hmac', 'html', 'http', 'imaplib', 'imghdr', 'imp', 'importlib', 'inspect', 'io', 'ipaddress', 'itertools', 'json', 'keyword', 'lib2to3', 'linecache', 'locale', 'logging', 'lzma', 'macpath', 'mailbox', 'mailcap', 'marshal', 'math', 'mimetypes', 'mmap', 'modulefinder', 'msilib', 'msvcrt', 'multiprocessing', 'netrc', 'nis', 'nntplib', 'ntpath', 'numbers', 'operator', 'optparse', 'os', 'ossaudiodev', 'parser', 'pathlib', 'pdb', 'pickle', 'pickletools', 'pipes', 'pkgutil', 'platform', 'plistlib', 'poplib', 'posix', 'posixpath', 'pprint', 'profile', 'pstats', 'pty', 'pwd', 'py_compile', 'pyclbr', 'pydoc', 'queue', 'quopri', 'random', 're', 'readline', 'reprlib', 'resource', 'rlcompleter', 'runpy', 'sched', 'secrets', 'select', 'selectors', 'shelve', 'shlex', 'shutil', 'signal', 'site', 'smtpd', 'smtplib', 'sndhdr', 'socket', 'socketserver', 'spwd', 'sqlite3', 'sre', 'sre_compile', 'sre_constants', 'sre_parse', 'ssl', 'stat', 'statistics', 'string', 'stringprep', 'struct', 'subprocess', 'sunau', 'symbol', 'symtable', 'sys', 'sysconfig', 'syslog', 'tabnanny', 'tarfile', 'telnetlib', 'tempfile', 'termios', 'test', 'textwrap', 'threading', 'time', 'timeit', 'tkinter', 'token', 'tokenize', 'trace', 'traceback', 'tracemalloc', 'tty', 'turtle', 'turtledemo', 'types', 'typing', 'unicodedata', 'unittest', 'urllib', 'uu', 'uuid', 'venv', 'warnings', 'wave', 'weakref', 'webbrowser', 'winreg', 'winsound', 'wsgiref', 'xdrlib', 'xml', 'xmlrpc', 'zipapp', 'zipfile', 'zipimport', 'zlib', 'zoneinfo')

Python & Config File Name: known_standard_library

CLI Flags: -b 、--builtin

標準ライブラリの追加

Pythonの標準ライブラリに含まれるモジュールのリストに含まれる追加モジュールです。

Type: Frozenset

Default: frozenset()

Python & Config File Name: extra_standard_library

CLI Flags: --extra-builtin

その他の既知のライブラリ

Type: Dict

Default: {}

Python & Config File Name: known_other

CLI Flags: ありません

使用例

.isort.cfg での例

code: .isort.cfg

settings

sections=FUTURE,STDLIB,THIRDPARTY,AIRFLOW,FIRSTPARTY,LOCALFOLDER

known_airflow=airflow

pyproject.toml での例

code: pyproject.toml

tool.isort

sections = 'FUTURE', 'STDLIB', 'THIRDPARTY', 'AIRFLOW', 'FIRSTPARTY', 'LOCALFOLDER'

known_airflow = 'airflow'

マルチライン出力

複数行の出力での折返しモードを指定します。指定可能な値は 0 〜11 の数値、もしくはモード名です。

table: マルチラインの出力モード

モード番号モード名

0 GRID

1 VERTICAL

2 HANGING_INDENT

3 VERTICAL_HANGING_INDENT

4 VERTICAL_GRID

5 VERTICAL_GRID_GROUPED

6 VERTICAL_GRID_GROUPED_NO_COMMA

7 NOQA

8 VERTICAL_HANGING_INDENT_BRACKET

9 VERTICAL_PREFIX_FROM_MODULE_IMPORT

10 HANGING_INDENT_WITH_PARENTHESES

11 BACKSLASH_GRID

Type: Wrapmodes

Default: 0 WrapModes.GRID

Python & Config File Name: multi_line_output

CLI Flags: -m 、 --multi-line

使用例

.isort.cfg での例

code: .isort.cfg

settings

multi_line_output=3

pyproject.toml での例

code: pyproject.toml

tool.isort

multi_line_output = 3

強制的に分割

Type: Tuple

Default: ()

Python & Config File Name: forced_separate

CLI Flags: ありません

インデント

インデントを配置する文字列のデフォルトを4つの空白文字(" ")にする。

Type: String

Default:　なし

Python & Config File Name: indent

CLI Flags: -i 、 --indent

コメントプレフィックス

Type: String

Default: #

Python & Config File Name: comment_prefix

CLI Flags: ありません

長さでソート

インポートする文字列の長さでソートする。

Type: Bool

Default: False

Python & Config File Name: length_sort

CLI Flags: --ls 、 --length-sort

直接的なインポートを長さでソート

直接的なインポート(ストレートインポート) (例：import a) を長さでソートします。length_sortに似ていますが、ストレートインポートのみに適用され、fromインポートには影響しません。

Type: Bool

Default: False

Python & Config File Name: length_sort_straight

CLI Flags: --lss　、 --length-sort-straight

セクション別に長さでソート

Type: Frozenset

Default: frozenset()

Python & Config File Name: length_sort_sections

CLI Flags: ありません

インポートの追加

指定されたインポート行をすべてのファイルに追加し、正しい配置を自動的に決定します。

Type: Frozenset

Default: frozenset()

Python & Config File Name: add_imports

CLI Flags: -a 、 --add-import

インポートの削除

指定されたインポート行をすべてのファイルから削除し、正しい配置を自動的に決定します。

Type: Frozenset

Default: frozenset()

Python & Config File Name: remove_imports

CLI Flags: --rm 、 --remove-import

アペンドのみ

ファイルに既存のインポートが含まれている場合、--add-importで指定されたインポートのみを追加します。

Type: Bool

Default: False

Python & Config File Name: append_only

CLI Flags: --append 、 --append-only

相対的なインポートをリバース

相対的なインポートの逆順でソート

Type: Bool

Default: False

Python & Config File Name: reverse_relative

CLI Flags: --rr 、 ---reverse-relative

単一行に強制

すべてのインポートを独立した単一行に強制します。

Type: Bool

Default: False

Python & Config File Name: force_single_line

CLI Flags: --sl 、 --force-single-line-imports

単一行の除外

単一行ルールから除外する1つ以上のモジュールを指定します。

Type: Tuple

Default: ()

Python & Config File Name: single_line_exclusions

CLI Flags: --nsl 、 --single-line-exclusions

デフォルトセクション

インポート・オプションのデフォルト・セクションを設定します。

指定可能な値は、('FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER') です。

Type: String

Default: THIRDPARTY

Python & Config File Name: default_section

CLI Flags: --sd 、 --section-default

インポートの見出し

Type: Dict

Default: {}

Python & Config File Name: import_headings

CLI Flags: ありません

バランスラッピング

バランスの取れたラッピング(折返し）で、最も安定したラインの長さを実現しようとします。

Type: Bool

Default: False

Python & Config File Name: balanced_wrapping

CLI Flags: -e 、 --balanced

括弧の使用

行長の制限時のときに、行の継続で、バックスラッシュの代わりに括弧を使用します。

注意：これはwrapモードとは別のもので、長すぎる個々の行の継続方法にのみ影響し、複数のインポートのセクションには影響しません。

Type: Bool

Default: False

Python & Config File Name: use_parentheses

CLI Flags: --up 、 --use_parentheses

タイプ別にソート

アルファベット順に加えて、大文字によって決定されるタイプ別にインポートを並べます。

注意：ここでいうタイプとは、インポート名の大文字から暗示されるタイプを指します。isortはインポートのタイプのイントロスペクションを行いません。これらの「型」は単に CONSTANT_VARIABLE、CamelCaseClass, variable_or_function となります。もしあなたのプロジェクトがPEP8やそれに関連したコーディングスタイルガイドに従っており、多くのインポートを持っているなら、これは良いデフォルトです。コマンドラインオプションの --dont-order-by-type この機能をオフにすることができます。

Type: Bool

Default: True

Python & Config File Name: order_by_type

CLI Flags: --ot 、--order-by-type

アトミック

出力ファイルに構文エラーが含まれている場合、出力を保存しないようにします。

Type: Bool

Default: False

Python & Config File Name: atomic

CLI Flags: --ac 、 --atomic

インポートのあとの行数

Type: Int

Default: -1

Python & Config File Name: lines_after_imports

CLI Flags: --lai 、 --lines-after-imports

セクション間の行数

Type: Int

Default: 1

Python & Config File Name: lines_between_sections

CLI Flags: ありません

タイプ間の行数

Type: Int

Default: 0

Python & Config File Name: lines_between_types

CLI Flags: --lbt 、 --linesss-between-types

同一のインポートとして結合する

複数のインポートを同一のインポートとしてまとめて表示します。

Type: Bool

Default: False

Python & Config File Name: combine_as_imports

CLI Flags: --ca 、 --combine-as

スターの結合

スターのインポート（例： from A import *) が存在する場合、その名前空間から他のものがインポートされないようにします。

Type: Bool

Default: False

Python & Config File Name: combine_star

CLI Flags: --cs 、 --combine-star

末尾のコンマ

括弧を含む複数行のインポートでは末尾のコンマ(Trailing Comma) が含まれるようにします。

Type: Bool

Default: False

Python & Config File Name: include_trailing_comma

CLI Flags: --tc 、 --trailing-comma

FROMファースト

一般的な順序を変更して、FROMインポートから順に表示し、ストレートインポートを表示します。

Type: Bool

Default: False

Python & Config File Name: from_first

CLI Flags: --ff 、 --from-first

Verbose

ファイルがスキップされたときや、チェックが成功したときなど、詳細な出力を表示します。

Type: Bool

Default: False

Python & Config File Name: verbose

CLI Flags: -v 、　--verbose

Quiet

非常に静かな出力を示し、エラーのみが出力されます。

Type: Bool

Default: False

Python & Config File Name: quiet

CLI Flags: -q 、 --quiet

強制追加

元のファイルが空であっても、強制的に追加することができます。

Type: Bool

Default: False

Python & Config File Name: force_adds

CLI Flags: --af 、 --force-adds

セクション内でのアルファベット順のソートを強制

すべてのインポートファイルをセクション内でアルファベット順に並べるようにします。

Type: Bool

Default: False

Python & Config File Name: force_alphabetical_sort_within_sections

CLI Flags: --fass 、 --force-alphabetical-sort-within-sections

アルファベット順にソート

すべての輸入品を1つのセクションとして強制的にソートします。

Type: Bool

Default: False

Python & Config File Name: force_alphabetical_sort

CLI Flags: --fas 、 --force-alphabetical-sort

GRIDラップの強制

行の長さにかかわらず、インポートの数（デフォルトは2）によって、GRIDラップさせることを強制します。0 が渡された場合（グローバル・デフォルト）は、行の長さのみが考慮されます。

Type: Int

Default: 0

Python & Config File Name: force_grid_wrap

CLI Flags: --fgw 、 --force-grid-wrap

セクション内での強制ソート

ストレートインポート(import sysなど)をFROMインポート(from itertools import groupbyなど)の前に並べることはありません。代わりに、インポートのスタイルに関係なく、モジュールごとにソートします。

Type: Bool

Default: False

Python & Config File Name: force_sort_within_sections

CLI Flags: --fss 、 --force-sort-within-sections

Lexicographical

Type: Bool

Default: False

Python & Config File Name: lexicographical

CLI Flags: ありません

パッケージ別にグループ化

Type: Bool

Default: False

Python & Config File Name: group_by_package

CLI Flags: ありません

空白文字の無視

--check-only が使用されているときに、空白文字の違いを無視するように isort に指示します。

Type: Bool

Default: False

Python & Config File Name: ignore_whitespace

CLI Flags: --ws 、 --ignore-whitespace

空行を前に挿入しない

空行で前のセクションと分割してはならないセクションを指示します。

Type: Frozenset

Default: frozenset()

Python & Config File Name: no_lines_before

CLI Flags: --nlb 、 --no-lines-before

行中でのソートはしない

複数のインポートを含むFROMインポートはソートせずに、そのままにしておく。 (例: from foo import a, c ,b)

Type: Bool

Default: False

Python & Config File Name: no_inline_sort

CLI Flags: --nis 、 --no-inline-sort

コメントを無視

No Description

Type: Bool

Default: False

Python & Config File Name: ignore_comments

CLI Flags: ありません

大文字小文字を区別

モジュール名をソートするときに大文字小文字を区別するようにする

Type: Bool

Default: False

Python & Config File Name: case_sensitive

CLI Flags: --case-sensitive

Sources

No Description

Type: Tuple

Default: ()

Python & Config File Name: sources

CLI Flags: ありません

仮想環境

パッケージがサードパーティであるかどうかを判断するために使用する仮想環境

Type: String

Default: ''

Python & Config File Name: virtual_env

CLI Flags: --virtual-env

Conda環境

パッケージがサードパーティであるかどうかを判断するために使用するConda環境

Type: String

Default: ''

Python & Config File Name: conda_env

CLI Flags: --conda-env

コメントの前に改行を挿入

インポート後のコメントの前に空白行を挿入します

Type: Bool

Default: False

Python & Config File Name: ensure_newline_before_comments

CLI Flags: -n 、 --ensure-newline-before-comments

Directory

No Description

Type: String

Default: ''

Python & Config File Name: directory

CLI Flags: ありません

プロファイル

構成に使用する基本プロファイルを指定。プロファイルには、共有プロファイルの他に、black、django、pycharm、google、open_stack、plone、attrs、hug、wemake、appnexus があります。

Type: String

Default: ''

Python & Config File Name: profile

CLI Flags: --profile

NOQAを尊重

isortに noqaコメントを尊重するように指示し、コメントされた行をスキップするようにします。

Type: Bool

Default: False

Python & Config File Name: honor_noqa

CLI Flags: --honor-noqa

ソースパス

明示的に定義されたソースパスを追加します（ソースパス内のモジュールは、そのインポートが自動的に first_party に分類されます）。このオプションでは、Glob展開（*と**）がサポートされています。

Type: Tuple

Default: ()

Python & Config File Name: src_paths

CLI Flags: --src 、 --src-path

古いファインダー

環境イントロスペクションマジックに依存した古い非推奨のファインダーロジックを使用します。

Type: Bool

Default: False

Python & Config File Name: old_finders

CLI Flags: --old-finders 、 --magic-placement

冗長なエイリアスの削除

isort に、import os as os のような冗長なエイリアスをインポートから削除するように指示します。これはデフォルトでは False になっていますが、これは、プロジェクトによっては、意図を示したり、動作を変えたりするために、このような一見無駄に見えるエイリアスを使うことがあります。

Type: Bool

Default: False

Python & Config File Name: remove_redundant_aliases

CLI Flags:　--remove-redundant-aliases

トップに移動

インデントされていないすべてのインポートを、インポートがソートされているファイルの先頭（ファイルコメントの先頭のすぐ下）に移動します。これは、ファイルの中央にインポートを配置したときに、コンテキストの切り替えを避けるために、たまにインポートを集めるための優れたショートカットになります。

注意：現在のところcimportsとは連動しておらず、余分なオーバーヘッドとパフォーマンス上のペナルティが発生します。

Type: Bool

Default: False

Python & Config File Name: float_to_top

CLI Flags: --float-to-top

ファイルのフィルタ

CLIコマンドの一部としてファイルが明示的に渡された場合でも、isortにファイルのフィルタリングを指示します。

Type: Bool

Default: False

Python & Config File Name: filter_files

CLI Flags: --filter-files

フォーマッター

出力を生成するために使用されるフォーマッタープラグインの名前を指定します。

Type: String

Default: ''

Python & Config File Name: formatter

CLI Flags: --formatter

フォーマット関数

Type: Nonetype

Default: None

Python & Config File Name: formatting_function

CLI Flags: ありません

カラー出力

端末の出力に色を使うようにisortに指示します。

Type: Bool

Default: False

Python & Config File Name: color_output

CLI Flags: --color

コメントをコードとして扱う

指定した一行コメントをコードとして扱うようにisortに指示します。

Type: Frozenset

Default: frozenset()

Python & Config File Name: treat_comments_as_code

CLI Flags: --treat-comment-as-code

すべてのコメントをコードとして扱う

すべての一行コメントをコードとして扱うようにisortに指示します。

Type: Bool

Default: False

Python & Config File Name: treat_all_comments_as_code

CLI Flags: --treat-all-comment-as-code

サポートする拡張子

Supported Extensions

isortが実行可能な拡張子を指定します。

Type: Frozenset

Default: ('pxd', 'py', 'pyi', 'pyx')

Python & Config File Name: supported_extensions

CLI Flags: --ext 、--extension 、 --supported-extension

ブロックする拡張子

isortを実行させない拡張子を指定します。

Type: Frozenset

Default: ('pex',)

Python & Config File Name: blocked_extensions

CLI Flags: --blocked-extension

定数

Type: Frozenset

Default: frozenset()

Python & Config File Name: constants

CLI Flags: ありません

クラス

Type: Frozenset

Default: frozenset()

Python & Config File Name: classes

CLI Flags: ありません

変数

Type: Frozenset

Default: frozenset()

Python & Config File Name: variables

CLI Flags: ありません

見出しの控除

コメントが設定されているセクションが複数ある場合でも、カスタムインポート見出しのコメントを一度だけ表示するようにisortに指示します。

Type: Bool

Default: False

Python & Config File Name: dedup_headings

CLI Flags: --dedup-headings

セクションのみソート

STDLIB、THIRDPARTYなどのセクションに基づいて、インポートをソートします。セクション内では、インポートはそのインポートスタイルで並べられ、同じスタイルのインポートは相対的な位置を維持します。

Type: Bool

Default: False

Python & Config File Name: only_sections

CLI Flags: --os 、 --only-sections

変更したファイルのみ

変更されていないファイルに対する冗長な出力を抑制します。

Type: Bool

Default: False

Python & Config File Name: only_modified

CLI Flags: --om 、 --only-modified

ストレートインポートをまとめる

同じセクションのすべてのベアストレートインポートを1行にまとめます。エイリアス(as) のインポートを持つセクションでは動作しません。

Type: Bool

Default: False

Python & Config File Name: combine_straight_imports

CLI Flags: --csi 、 --combine-straight-imports

名前空間パッケージを自動識別

Type: Bool

Default: True

Python & Config File Name: auto_identify_namespace_packages

CLI Flags: ありません

名前空間パッケージを指示

Type: Bool

Default: True

Python & Config File Name: namespace_packages

CLI Flags: ありません

リンクをフォロー

isort が再帰的に実行される際に遭遇するシンボリックリンクを辿るようにします。

Type: Bool

Default: True

Python & Config File Name: follow_links

CLI Flags: ありません

インデントされたインポートの見出し

Type: Bool

Default: True

Python & Config File Name: indented_import_headings

CLI Flags: ありません

ソートされたセクションで大文字小文字を尊重

--force-sort-within-sections が使われているときに --case-sensitive を尊重します。このオプションが設定されていない場合、--order-by-type はモジュール名の順序も決定します。

Type: Bool

Default: False

Python & Config File Name: honor_case_in_force_sorted_sections

CLI Flags: --hcss 、 --honor-case-in-force-sorted-sections

強制ソートされたセクションでの相対的なソート

--force-sort-within-sections を使用すると、その設定を使用していない場合と同じ方法で相対的なインポートをソートします。

Type: Bool

Default: False

Python & Config File Name: sort_relative_in_force_sorted_sections

CLI Flags: --srss 、 --sort-relative-in-force-sorted-sections

上書き

isort に、同じファイルハンドルを使って所定の場所に上書きするように指示します。標準的な方法に比べてパフォーマンスとメモリ使用量が低下しますが、すべてのファイルフラグとモードが変更されないことが保証されています。

Type: Bool

Default: False

Python & Config File Name: overwrite_in_place

CLI Flags: --overwrite-in-place

リバースソート

インポートの順序を逆にします。

Type: Bool

Default: False

Python & Config File Name: reverse_sort

CLI Flags: --reverse-sort

スター型インポートを優先

スター型のインポートを他のインポートよりも優先させ、直接インポートされた変数をオーバーライドしないようにします。

Type: Bool

Default: False

Python & Config File Name: star_first

CLI Flags:　--star-first

Git Ignore

Type: Dict

Default: {}

Python & Config File Name: git_ignore

CLI Flags: ありません。

エラーフォーマット

エラーを表示する際のフォーマットを変更します。

Type: String

Default: {error}: {message}

Python & Config File Name: format_error

CLI Flags: --format-error

サクセスフォーマット

サクセスを表示するときのフォーマットを変更します。

Type: String

Default: {success}: {message}

Python & Config File Name: format_success

CLI Flags: --format-success

ソート順序

ソート関数を指定します。組み込みまたはインストール可能なプラグインを指定します。

natural=Val：強制的に連続させる数をval であたえる(デフォルト)

native = func：Pythonに内蔵されたソート関数 func で与える

Type: String

Default: natural

Python & Config File Name: sort_order

CLI Flags: --sort-order

バージョン表示

現在インストールされている　isort のバージョンを表示します。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: -V 、 --version

使用例

code: bash

$ isort --version

_ _

(_) ___ ___ _ __| |_

| |/ _/ / _ \/ '__ _/

| |\__ \/\_\/| | | |_

|_|\___/\___/\_/ \_/

isort your imports, so you don't have to.

VERSION 5.9.3

バージョン番号表示

現在インストールされている　isort のバージョンをロゴを除外して表示します。

Type: String

Default: ==SUPPRESS==

Python & Config File Name: 　ありません

CLI Flags: --vn 、 --version-number

使用例

code: bash

$ isort --version-number

5.9.3

標準出力へ出力

ファイルを書き換えずに、結果を標準出力に出力する

Type: Bool

Default: False

Python & Config File Name: 　ありません

CLI Flags: -d 、 --stdout

Show Config

isortの決定済みの構成、および構成オプションのソースを表示

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --show-config

Show Files

現在の設定オプションでisortが実行されるファイルを表示

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --show-files

Show Diff

ファイルを変更するのではなく，isort がファイルに加えるであろうすべての変更の差分を出力します

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --df 、 --diff

Check

ファイルを変更せずに、インポートがソートされていない/フォーマットされていないファイルをチェックして、コマンドラインに表示します。何も変更されない場合は 0を、ファイルが再フォーマットされる場合は 1 を返します。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: -c 、 --check-only 、 --check

パスの設定

ファイルの場所に基づいて自動判定するのではなく、設定のパスやファイルを明示的に設定します。

Type: String

Default: None

Python & Config File Name: ありません

CLI Flags: --sp 、 --settings-path 、 --settings-file 、 --settings

ジョブ数

並列に処理するファイル数を指示します。

Type: Int

Default: None

Python & Config File Name: ありません

CLI Flags: -j 、 --jobs

適用の確認

isortに、変更をインタラクティブに適用するように指示します。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --interactive

ファイル

インポートのソートが必要な1つまたは複数のPythonソースファイル。

Type: String

Default: None

Python & Config File Name: ありません

CLI Flags: ありません

リンクをフォローしない

isort が再帰的に実行される際に遭遇するシンボリックリンクを辿らないようにします。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --dont-follow-links

ファイル名

ストリームに関連するファイル名を指定します。

Type: String

Default: None

Python & Config File Name: ありません

CLI Flags:　--filename

ルートディレクトリを許可

isortがルートディレクトリ(/)を特別扱いしないようにして、ルートディレクトリに対して実行できるようにします。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --allow-root

トップに移動しない

--float-to-top の設定を強制的に解除します。詳しくは --float-to-top をご覧ください。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --dont-float-to-top

タイプ順でソートしない

インポートをアルファベット順に代えて大文字で決まるタイプ別に並べるようにしない。

注意：ここでいうタイプとは、インポート名の大文字から暗示されるタイプを指します。isortはインポートのタイプのイントロスペクションを行いません。これらの「型」は単に CONSTANT_VARIABLE、CamelCaseClass, variable_or_function となります。もしあなたのプロジェクトがPEP8やそれに関連したコーディングスタイルガイドに従っており、多くのインポートを持っているなら、これは良いデフォルトです。コマンドラインオプションの --order-by-type この機能をオンにすることができます。

Type: Bool

Default: False

Python & Config File Name: ありません

CLI Flags: --dt 、 --dont-order-by-type

拡張子フォーマット

isort に、指定されたファイルを拡張子のフォーマットルールに従ってフォーマットするように指示します。

Type: String

Default: None

Python & Config File Name: ありません

CLI Flags: --ext-format

非推奨フラグ

Type: String

Default: None

Python & Config File Name: ありません

CLI Flags: -k 、 --keep-direct-and-as